<html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head><title>mx.fmxis.FMXISButtonToggle Class</title><link rel="stylesheet" type="text/css" href="../../../docs.css"></link></head><body><h1>FMXISButtonToggle Class</h1><p><b>Class </b>mx.fmxis.FMXISButtonToggle</p><p><b>Inheritance </b>
			
			&gt;
			
		<a href="../FMXISBase/Class.htm">FMXISBase</a>
			
			&gt;
			
		<a href="Class.htm">FMXISButtonToggle</a></p><div class="description"><p>This class implements a simple toggle button.  Users can change the
appearance by changing the <i>defaultButTogUp</i> and <i>defaultButTogDn</i> movie clips
in the Library.</p>
<br /><br />
<p>The class has two events, by default called:</p>
<li><code>onSet</code> - Generated when button goes from up to down position</li>
<li><code>onUnset</code> - Generated when button goes from down to up position</li>
<br /><br />
<p>The event names can be changed (if desired) in the component property inspector or on initialization through
the <code>initObject</code> of <code>attachMovie()</code>.</p>
<br /><br />
<p>This class inherits from FMXISBase to get listener capabilities.</p></div><table border="1" cellpadding="2" cellspacing="0"><tr><th colspan="2" class="ObjectsSummaryHeading">Property Summary</th></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type"></span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#butIsUp">butIsUp</a></div><div class="functionSummaryLine">Whether the button is in the up (unset) position -- true -- on first viewing, or
in the down (set) position -- false.</div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;static&nbsp;</span><span class="type">Array</span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#buttonEvents">buttonEvents</a></div><div class="functionSummaryLine"></div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type">String</span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#className">className</a></div><div class="functionSummaryLine"></div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type">String</span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#evtSet">evtSet</a></div><div class="functionSummaryLine">Event name for when button is put in the set (down) position.</div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;static&nbsp;</span><span class="type">String</span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#symbolName">symbolName</a></div><div class="functionSummaryLine"></div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;static&nbsp;</span><span class="type">Object</span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#symbolOwner">symbolOwner</a></div><div class="functionSummaryLine"></div></td></tr></table><table border="1" cellpadding="2" cellspacing="0" class="inheritedObjects"><tr><th class="InheritedHeading">Properties inherited from mx.fmxis.FMXISBase</th></tr><tr><td><div class="inheritedMemberList"><a href="../FMXISBase/Class.htm#addEventListener">addEventListener</a>, <a href="../FMXISBase/Class.htm#clipParameters">clipParameters</a>, <a href="../FMXISBase/Class.htm#removeEventListener">removeEventListener</a></div></td></tr></table><table border="1" cellpadding="2" cellspacing="0"><tr><th colspan="2" class="ObjectsSummaryHeading">Method Summary</th></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type"></span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#execEvent">execEvent</a>(evtName, evtVal, q)</div><div class="functionSummaryLine">This method is used to programmatically invoke an action of the component based on
the event passed in.</div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type"></span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#onPress">onPress</a>(q:Boolean)</div><div class="functionSummaryLine">Called to invoke action of pressing the button.</div></td></tr></table><table border="1" cellpadding="2" cellspacing="0" class="inheritedObjects"><tr><th class="InheritedHeading">Methods inherited from mx.fmxis.FMXISBase</th></tr><tr><td><div class="inheritedMemberList"><a href="../FMXISBase/Class.htm#addListener">addListener</a>, <a href="../FMXISBase/Class.htm#init">init</a>, <a href="../FMXISBase/Class.htm#removeListener">removeListener</a></div></td></tr></table><table border="1" cellpadding="2" cellspacing="0"><tr><th colspan="2" class="ObjectsSummaryHeading">Event Summary</th></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type"></span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#onSet">onSet</a></div><div class="functionSummaryLine">Event generated when button goes from the down to up position.</div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type"></span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#onUnset">onUnset</a></div><div class="functionSummaryLine"></div></td></tr></table><table border="1" cellpadding="2" cellspacing="0"><tr><th class="ObjectsDetailHeading">Property Detail</th></tr></table><div class="DetailRow"><a name="butIsUp"></a><div class="DetailObjectTitle">butIsUp</div><div class="DetailObjectDeclaration">public function get/set butIsUp()</div><div class="DetailDescription">Whether the button is in the up (unset) position -- true -- on first viewing, or
in the down (set) position -- false.</div></div><div class="DetailRow"><a name="buttonEvents"></a><div class="DetailObjectTitle">buttonEvents</div><div class="DetailObjectDeclaration"> static var buttonEvents:Array;</div><div class="DetailDescription"></div></div><div class="DetailRow"><a name="className"></a><div class="DetailObjectTitle">className</div><div class="DetailObjectDeclaration"> var className:String;</div><div class="DetailDescription"></div></div><div class="DetailRow"><a name="evtSet"></a><div class="DetailObjectTitle">evtSet</div><div class="DetailObjectDeclaration">public var evtSet:String;</div><div class="DetailDescription">Event name for when button is put in the set (down) position.  Change this value
at any time.</div></div><div class="DetailRow"><a name="symbolName"></a><div class="DetailObjectTitle">symbolName</div><div class="DetailObjectDeclaration"> static var symbolName:String;</div><div class="DetailDescription"></div></div><div class="DetailRow"><a name="symbolOwner"></a><div class="DetailObjectTitle">symbolOwner</div><div class="DetailObjectDeclaration"> static var symbolOwner:Object;</div><div class="DetailDescription"></div></div><table border="1" cellpadding="2" cellspacing="0"><tr><th class="ObjectsDetailHeading">Method Detail</th></tr></table><div class="DetailRow"><a name="execEvent"></a><div class="DetailObjectTitle">execEvent</div><div class="DetailObjectDeclaration"> function  execEvent(evtName, evtVal, q)</div><div class="DetailDescription">This method is used to programmatically invoke an action of the component based on
the event passed in.  When a user invokes an action, like presses a button, the button
generates an onPress event.  This method does the opposite -- given an onPress event, this
the method visually depresses the button.  This is typically used to simulate the user invoking the action.</div><div class="DetailParamsTitle">Parameters:</div><div class="DetailParamsLine"><code>evtName</code> - Event name (string) must match the event this component generates</div><div class="DetailParamsLine"><code>evtVal</code> - Event value (for button, this value is ignored)</div><div class="DetailParamsLine"><code>quietly</code> - Boolean true to invoke action without generating the event, false or not given at all to allow event to be generated</div></div><div class="DetailRow"><a name="onPress"></a><div class="DetailObjectTitle">onPress</div><div class="DetailObjectDeclaration"> function  onPress(q:Boolean)</div><div class="DetailDescription">Called to invoke action of pressing the button.</div><div class="DetailParamsTitle">Parameters:</div><div class="DetailParamsLine"><code>quietly</code> - Boolean property indicating whether or not to suppress the event generation as a
result of the action.  Defaults to false (don't suppress event).</div></div><table border="1" cellpadding="2" cellspacing="0"><tr><th class="ObjectsDetailHeading">Event Detail</th></tr></table><div class="DetailRow"><a name="onSet"></a><div class="DetailObjectTitle">onSet</div><div class="DetailObjectDeclaration"> function  onSet(<i>eventObj</i>)</div><div class="DetailDescription">Event generated when button goes from the down to up position.</div></div><div class="DetailRow"><a name="onUnset"></a><div class="DetailObjectTitle">onUnset</div><div class="DetailObjectDeclaration"> function  onUnset(<i>eventObj</i>)</div><div class="DetailDescription"></div></div><br /><br /><hr /><span style='font-size: x-small; font-family: Verdana, Arial'>Documentation generated by <a href='http://wwww.blinex.com/products/bldoc' target='_blank' alt='BLDoc Link'>BLDoc Community Edition</a> from <a href='http://www.blinex.com' target='_blank' alt='B-Line Express Website'>B-Line Express</a>.</body></html>